home *** CD-ROM | disk | FTP | other *** search
/ The Games Machine 41 / RISING.iso / patch / Earthsiege 3 ATR / ES3ATRUpdate.exe / input.txt < prev    next >
Encoding:
Text File  |  1998-02-21  |  10.4 KB  |  277 lines
  1. ----------------------------------------------------------------------------------------------------
  2.                 INPUT MAPPING HELP TEXT
  3. ----------------------------------------------------------------------------------------------------
  4.  
  5. The purpose of this document is explain how to use StarSiege's input mapping utility.
  6. It will allow complete control over how you control your HERC.
  7.  
  8.     SECTIONS:
  9.     
  10.     1. CREATING A CUSTOM KEYMAPPING
  11.     2. USING MAKES AND BREAKS
  12.     3. USING PARAMETERS
  13.     4. LOADING A CUSTOM KEYMAPPING
  14.     5. INPUT
  15.     6. ACTION DEFINITIONS
  16.     7. EXAMPLES
  17.  
  18.  
  19.  
  20. 1. CREATING A CUSTOM KEYMAPPING
  21. -------------------------------
  22.  
  23. First, open any *.cs file located in the install directory (usually c:\games\Es3Alpha\Keymaps) 
  24. Notice that it is divided into 3 different sections ( Camera, CameraOrbit,and Herc ). 
  25. The different sections indicate the control scheme for different control modes.  For example, 
  26. when piloting a HERC, the Herc control section will be used, or when in an external camera view, 
  27. the CameraOrbit control section will be used.
  28.  
  29. The Keymapping files can be nested, or "included" within each other. In the Joystick.cs file,
  30. the following lines indicate other keymap files that are combined with the joystick.cs
  31. file to create a complete keymap for multiple input devices and functions:
  32.  
  33. #------------------------------------------------------------------------------
  34. # include generic camera controls
  35. exec _defCamera.cs
  36.  
  37.  
  38. #------------------------------------------------------------------------------
  39. # include generic keyboard controls
  40. exec _defKeyboard.cs
  41.  
  42.  
  43. This is done mainly for convenience. If you wish to create a single file that contains 
  44. "everything" you can do so.
  45.  
  46.  
  47. 2. USING MAKES AND BREAKS 
  48. -------------------------------
  49.  
  50. It is crucial to use the "make" and "break" keywords correctly.  When binding input to actions such as
  51. firing, moving, or looking ( actions that should generally occur only when holding down a key or button ), 
  52. use the "make" to initiate the action, and "break" to turn it off.
  53. Example:
  54.  
  55. "bindAction keyboard make space TO ACTION_FIRE 1.0"
  56. "bindAction kyboard break space TO ACTION_FIRE 0.0"
  57.  
  58. The value at the end represents a toggle, where 1.0 is on and 0.0 is off.
  59.  
  60.  
  61. 3.  USING PARAMETERS 
  62. --------------------------------
  63.  
  64. Most actions require a value at the end of a binding statement ( see ACTION DEFINITIONS below for more info ). 
  65. There are five additional parameters that you have the option of using.  They are: 
  66.  
  67. flip:        Reverses the coordinate system for the chosen action (ACTION_YAW -1.0 would turn left instead of right)
  68.         Example : "bindAction joystick yaxis TO ACTION_LOOK_Y flip" 
  69.  
  70. deadzone:    Kills all input that lies within the specified range.
  71.         (e.g.,If you enter 'deadzone 0.1', the deadzone will be 10% of your total axis ).
  72.         Example: "bindAction joystick xaxis TO ACTION_YAW deadzone 0.1" 
  73.  
  74. center:        Centers your the coordinate system of your control device from (0.0, 1.0) to (-1.0,1.0)
  75.         Example: "bindAction joystick yaxis TO ACTION_SPEED center"        
  76.  
  77. square:        Changes the growth rate of constant input (e.g., pulling down on a joystick)from linear to parabolic.
  78.         Example: "bindAction joystick yaxis TO ACTION_SPEED square"
  79.  
  80. scale:        Scales the sensitivity of an input signal, based on the value you give it.  
  81.         Example:"bindAction joystick zaxis TO ACTION_SPEED scale 0.2
  82.  
  83. Note that it is possible to string five of these parameters onto the end of one action.  For example,
  84. you could enter a line that looked like this: 
  85.  
  86. "bindAction joystick yaxis TO ACTION_SPEED deadzone 0.2 center square scale 0.1".
  87.  
  88. This would have the effect of giving a deadzone of 20% in the center the yaxis of your joystick, 
  89. while scaling the input signal by a factor of 0.1. Pushing forward would increase your HERC's forward throttle 
  90. at a parabolic rate, and pulling back would do the same thing, in reverse.
  91. Obviously, other combinations are possible.
  92.  
  93. 4.  LOADING A CUSTOM KEYMAP FILE
  94. --------------------------------
  95.  
  96. In order to load a custom keymap file, it needs to  be located in the ..\es3Alpha\keymaps directory.
  97. At the Player Setup Menu, click on the Input Configuration field. This will call up a list of the
  98. available KeyMap files.  Highlight the one you want to load. 
  99.  
  100.  
  101. 5.  INPUT
  102. --------------------------------------------------------------------------------------------
  103.  
  104. JOYSTICK INPUT( keyword is "joystick" ):
  105.  
  106. "zaxis"
  107. "yaxis"
  108. "xaxis"
  109. "rzaxis"
  110. "rxaxis"
  111. "ryaxis"
  112. "slider0"
  113. "slider1"
  114. "xpov"
  115. "ypov"
  116. "button0"
  117. "button1"
  118. "button2"
  119. "button3" 
  120. "button4"
  121. "button5"
  122. "button6"
  123. "button7"
  124. "button8"
  125. "button9"
  126. "button10"
  127. "button11"
  128. "button12"
  129.  
  130. MOUSE INPUT( keyword is "mouse" ):
  131.  
  132. "xaxis"
  133. "yaxis"
  134. "zaxis"
  135. "button0"
  136. "button1"
  137. "button2"
  138. "button3"
  139.  
  140. KEYBOARD INPUT( keyword is "keyboard" ):
  141.  
  142. Note that key modifiers( alt, shift, control) are supported, 
  143. but the modifier must come before the key (e.g., "shift s").
  144. Any key not listed below is represented by it's direct keyboard character.
  145.  
  146. "escape"      Esc
  147. "backspace"    BackSpace
  148. "tab"        Tab
  149. "enter"        Enter
  150. "control"    Control
  151. "shift"        Shift
  152. "alt"        Alt
  153. "capslock"    Caps Lock    
  154. "numlock"    Num Lock
  155. "numpad1"    Numpad1
  156. "numpad2"    Numpad2
  157. "numpad3"    Numpad3
  158. "numpad4"    Numpad4
  159. "numpad5"    Numpad5
  160. "numpad6"    Numpad6
  161. "numpad7"    Numpad7
  162. "numpad8"     Numpad8
  163. "numpad9"    Numpad9
  164. "numpad0"    Numpad0
  165. "numpad+"       Numpad plus
  166. "numpad-"    Numpad minus
  167. "numpad/"    Numpad slash
  168. "numpad*"       Numpad star
  169. "scroll"    Scroll Lock
  170. "numpadequals"    Numpad Equals
  171. "stop"        Stop
  172. "numpadenter"    Numpad Enter
  173. "numpadcomma"    Numpad Comma
  174. "sysreq"    Print Screen/ Sys Req
  175. "home"        Home
  176. "up"        Up Arrow
  177. "down"        Down Arrow
  178. "left"        Left Arrow
  179. "right"        Right Arrow
  180. "end"        End
  181. "next"        Next
  182. "insert"    Insert
  183. "delete"    Delete
  184. "win"        Windows
  185. "app"        Apps
  186.  
  187.  
  188. 6.  ACTION DEFINITIONS
  189. ------------------------------------------------------------------------------
  190.  
  191. ACTIONS                PARAMETER DEFINITIONS    
  192.  
  193. ACTION_NAVPOINT_NEXT        No value needed, Selects to next navpoint
  194. ACTION_NAVPOINT_PREV        No value needed, Selects to previous navpoint
  195. ACTION_NAVPOINT_SET        Value selects navpoint
  196. ACTION_NEXT            No value needed, jumps to next HERC while in OrbitCamera mode
  197. ACTION_PREV            No value needed, jumps to previous HERC while in OrbitCamera mode
  198. ACTION_REVERSE_THROTTLE:    No value needed, toggles reverse throttle
  199. ACTION_LOOK_CENTER:        No value needed, centers pov
  200. ACTION_ZOOM_SET:        Values range from 0.0 to 1.0, sets zoom level
  201. ACTION_ZOOM_ADJUST:        Values range from -1.0 to 1.0, adjusts zoom level based on value
  202. ACTION_SPEED:            1.0 equals max speed, -1.0 equals reverse, 0.0 equals stop
  203. ACTION_ROLL:            1.0 equals max roll left, -1.0 equals max roll right
  204. ACTION_PITCH:            1.0 equals max pitch forward, -1.0 equals max pitch backwards
  205. ACTION_YAW:            1.0 equals max yaw left, -1.0 equals max yaw right             
  206. ACTION_STOP:            No value needed, stops the HERC
  207. ACTION_MOVE_X:            1.0 move the camera to the left, -1.0 moves the camera to the right
  208. ACTION_MOVE_Y:            1.0 moves the camera towards your pov,-1.0 moves it away
  209. ACTION_MOVE_Z:            1.0 moves the camera up, -1.0 moves the camera down
  210. ACTION_WEAPON_ADJ:        1.0 selects next weapon, -1.0 selects previous weapon
  211. ACTION_SELECT_WEAPON:        Values range from 0.0 to 8.0, number indicates which weapon to select
  212. ACTION_REACTOR:            No value needed, turns power off ( crucial for using loading and healing pads ).
  213. ACTION_LOOK_X:            1.0 looks left, -1.0 looks right
  214. ACTION_LOOK_Y:            1.0 looks up, -1.0 looks down
  215. ACTION_FIRE:            1.0 fires, 0.0 stops firing, -1.0 fires all weapons at once ( "Alpha Strike" )
  216. ACTION_WEAPON_LINK        No values, needed, works as a toggle to link like weapons
  217. ACTION_CAMOUFLAGE:        No value needed, toggles camouflage
  218. ACTION_USE_PROJECTILE_CAM:    No value needed, camera follows your next shot
  219. ACTION_CROUCH:            1.0 crouches, 0.0 stops crouching
  220. ACTION_SHIELD:            No value needed,toggles shields
  221. ACTION_SHIELD_TRACK        No values needed,toggles, toggles shield track
  222. ACTION_SHIELD_FOCUS_SET:    Value ranges from 0.0 to 1.0, value sets focus
  223. ACTION_SHIELD_FOCUS_ADJ :    Value ranges from 0.0 to 1.0, Value is added to current focus of your shield
  224. ACTION_SHIELD_ROTATION_ADJ:    Value range from 0.0 to 1.0, Value is added the current position of your shield 
  225. ACTION_SHIELD_ROTATION_SET:    Value ranges from 0.0 to 1.0, value sets shield position, with 0.0 being front. 
  226. ACTION_TARGET_ADJ:        1.0 targets the next  available target, -1.0 targets the previous available target
  227. ACTION_TARGET_CLOSEST:        No value needed, Targets closest targettable object
  228. ACTION_TARGET_SELECTED:        No value needed, Targets object currently underneath reticle
  229. ACTION_SENSOR_RANGE_TOGGLE:    No value needed, toggles radar
  230. ACTION_SENSOR_RANGE_SET:    Values range from 1.0 to 0.0, sets range of sensors
  231. ACTION_SENSOR_MODE_TOGGLE:    No Values needed, toggles from passive to active
  232.  
  233.  
  234. 7.  EXAMPLES
  235. -----------------------------------------------------------------------------------
  236. These examples are some of the more commonly asked questions about creating a custom keymapping:
  237.  
  238. Q: How do I use my joystick axis to look?
  239.  
  240. A: bindAction joystick xaxis TO ACTION_LOOK_X deadzone 0.1 center square
  241.    bindAction joystick yaxis TO ACTION_LOOK_Y deadzone 0.1 center square
  242.    
  243.  
  244. Q: How do I use the joystick hat to look?
  245.  
  246. A: bindAction joystick xpov TO ACTION_LOOK_X flip
  247.    bindAction joystick ypov TO ACTION_LOOK_Y 
  248.  
  249.  
  250. Q: How do I reconfigure the throttle ?
  251.  
  252. A: It depends on which device you want to use as input.  For keyboard, you might want something like this:
  253.         
  254.     bindAction keyboard make up TO ACTION_SPEED +1.0
  255.     bindAction keyboard break up TO ACTION_SPEED  0.0
  256.  
  257.    For joystick zaxis ( throttle ):
  258.    
  259.     bindAction joystick zaxis TO ACTION_SPEED deadzone 0.1 center square
  260.  
  261.  
  262. Q: When I look with my mouse/ joystick/ keyboard, the HERC response seems backwards.  How do I fix this ?
  263.     
  264. A: Simply add the flip parameter at the end of the appropriate action in your custom keymap file.
  265.    If flip is already there, remove it. This will flip the logical response of your HERC.
  266.  
  267.  
  268. Q: I added a keyboard command, but it dosn't seem to work. What's the deal?
  269.  
  270. A: Make sure you typed 'make' or 'break' before the specific key you wanted to bind.  Otherwise nothing will happen.
  271.    Also, key combinations involving more than two keys will not work.
  272.  
  273.  
  274. Q: Whenever I try to use the joystick hat, my HERC fires or does some other incorrect action.
  275.  
  276. A: Most likely you need to recalibrate your joystick.  To do this, select Start menu/settings/control panel/Game Controllers. 
  277.    and calibrate.